<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class SecurityCollection</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class SecurityCollection</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">SecurityCollection class</p>
<p class="description"><p>Representation of a web resource collection for a web application's security  constraint, as represented in a <div class="src-code"><ol><li><div class="src-line"><span class="src-sym">&amp;</span><span class="src-id">lt</span><span class="src-sym">;</span><span class="src-id">web</span>-<span class="src-id">resource</span>-<span class="src-id">collection</span><span class="src-sym">&amp;</span><span class="src-id">gt</span><span class="src-sym">;</span></div></li>
</ol></div>  element in the deployment descriptor.  &lt;p&gt;
 <strong>WARNING</strong>:  It is assumed that instances of this class will be created  and modified only within the context of a single thread, before the instance  is made visible to the remainder of the application.  After that, only read  access is expected.  Therefore, none of the read and write access within  this class is synchronized.</p></p>
		<p class="notes">
			Located in <a class="field" href="_aas---deploy---Deploy.php.html">/aas/deploy/Deploy.php</a> (line <span class="field">310</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																				
												<div class="method-definition">
											<span class="method-result">SecurityCollection</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>], [<span class="var-type">description</span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addMethod" title="details" class="method-name">addMethod</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$method</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addPattern" title="details" class="method-name">addPattern</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findMethod" title="details" class="method-name">findMethod</a>
											(<span class="var-type">method</span>&nbsp;<span class="var-name">$method</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findMethods" title="details" class="method-name">findMethods</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findPattern" title="details" class="method-name">findPattern</a>
											(<span class="var-type">pattern</span>&nbsp;<span class="var-name">$pattern</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findPatterns" title="details" class="method-name">findPatterns</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getDescription" title="details" class="method-name">getDescription</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getName" title="details" class="method-name">getName</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeMethod" title="details" class="method-name">removeMethod</a>
											(<span class="var-type">method</span>&nbsp;<span class="var-name">$method</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removePattern" title="details" class="method-name">removePattern</a>
											(<span class="var-type">pattern</span>&nbsp;<span class="var-name">$pattern</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setDescription" title="details" class="method-name">setDescription</a>
											(<span class="var-type">description</span>&nbsp;<span class="var-name">$description</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setName" title="details" class="method-name">setName</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">321</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Construct a new security collection instance with specified values.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">SecurityCollection</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>], [<span class="var-type">description</span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of this security collection</span>			</li>
					<li>
				<span class="var-type">description</span>
				<span class="var-name">$description</span><span class="var-description">: Description of this security collection</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddMethod" id="addMethod"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">addMethod</span> (line <span class="line-number">409</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add an HTTP request method to be part of this web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addMethod
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$method</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddPattern" id="addPattern"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addPattern</span> (line <span class="line-number">421</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a URL pattern to be part of this web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addPattern
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$pattern</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfindMethod" id="findMethod"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">findMethod</span> (line <span class="line-number">437</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the specified HTTP request method is  part of this web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findMethod
		</span>
					(<span class="var-type">method</span>&nbsp;<span class="var-name">$method</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">method</span>
				<span class="var-name">$method</span><span class="var-description">: Request method to check</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfindMethods" id="findMethods"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">findMethods</span> (line <span class="line-number">451</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the set of HTTP request methods that are part of this web  resource collection, or a zero-length array if all request methods  are included.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findMethods
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodfindPattern" id="findPattern"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">findPattern</span> (line <span class="line-number">463</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is the specified pattern part of this web resource collection?</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findPattern
		</span>
					(<span class="var-type">pattern</span>&nbsp;<span class="var-name">$pattern</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pattern</span>
				<span class="var-name">$pattern</span><span class="var-description">: Pattern to be compared</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfindPatterns" id="findPatterns"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">findPatterns</span> (line <span class="line-number">475</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the set of URL patterns that are part of this web resource  collection.  If none have been specified, a zero-length array is  returned.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findPatterns
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDescription" id="getDescription"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getDescription</span> (line <span class="line-number">362</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the description of this web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getDescription
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getName</span> (line <span class="line-number">384</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the name of this web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodremoveMethod" id="removeMethod"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">removeMethod</span> (line <span class="line-number">488</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove the specified HTTP request method from those that are part  of this web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeMethod
		</span>
					(<span class="var-type">method</span>&nbsp;<span class="var-name">$method</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">method</span>
				<span class="var-name">$method</span><span class="var-description">: Request method to be removed</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremovePattern" id="removePattern"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removePattern</span> (line <span class="line-number">509</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove the specified URL pattern from those that are part of this  web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removePattern
		</span>
					(<span class="var-type">pattern</span>&nbsp;<span class="var-name">$pattern</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pattern</span>
				<span class="var-name">$pattern</span><span class="var-description">: Pattern to be removed</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetDescription" id="setDescription"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setDescription</span> (line <span class="line-number">374</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the description of this web resource collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setDescription
		</span>
					(<span class="var-type">description</span>&nbsp;<span class="var-name">$description</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">description</span>
				<span class="var-name">$description</span><span class="var-description">: The new description</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetName" id="setName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setName</span> (line <span class="line-number">396</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the name of this web resource collection</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setName
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: The new name</span>			</li>
				</ul>
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">527</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return a $representation of this security collection.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 09 Feb 2008 12:02:30 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>